Skip to content

[FC-0099] feat: implement get_object method in scope data classes#124

Merged
mariajgrimaldi merged 5 commits intoopenedx:mainfrom
eduNEXT:bav/add-get-object-method
Oct 28, 2025
Merged

[FC-0099] feat: implement get_object method in scope data classes#124
mariajgrimaldi merged 5 commits intoopenedx:mainfrom
eduNEXT:bav/add-get-object-method

Conversation

@BryanttV
Copy link
Copy Markdown
Contributor

@BryanttV BryanttV commented Oct 28, 2025

Description

This PR includes a new method for the Scope Data classes (get_object). This is done for two main reasons:

  • To allow direct access to the object when related attributes are needed, for example, when used in a Casbin custom matcher to check permissions based on object attributes.
  • To address the current issue of storing non-canonical scope IDs, which leads to inconsistencies in permission validation.

Related Issues

Testing Instructions

Using Tutor:

  1. Install this plugin with the changes in this PR.
  2. Run the migrations by running tutor dev exec lms python manage.py lms migrate
  3. Load the default policies by running tutor dev exec lms python manage.py lms load_policies

Endpoint

PUT http://local.openedx.io:8000/api/authz/v1/roles/users/

{
    "users": ["steve"],
    "role": "library_admin",
    "scope": "lib:NotExistentOrg:NOTEXISTENTLIB"
}

Try assigning permissions to a library with an incorrect (non-canonical) ID — for example, using only uppercase or lowercase letters. You should see an error message indicating that the scope does not exist.

Merge Checklist:

Check off if complete or not applicable:

  • Version bumped
  • Changelog record added
  • Documentation updated (not only docstrings)
  • Fixup commits are squashed away
  • Unit tests added/updated
  • Manual testing instructions provided
  • Noted any: Concerns, dependencies, migration issues, deadlines, tickets

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Oct 28, 2025
@openedx-webhooks
Copy link
Copy Markdown

openedx-webhooks commented Oct 28, 2025

Thanks for the pull request, @BryanttV!

This repository is currently maintained by @openedx/committers-openedx-authz.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@BryanttV BryanttV marked this pull request as ready for review October 28, 2025 16:37
Copy link
Copy Markdown
Contributor

@bmtcril bmtcril left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Comment thread openedx_authz/api/data.py Outdated
>>> library_obj = library_scope.get_object() # ContentLibrary object
"""
try:
library_key = LibraryLocatorV2.from_string(self.library_id)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't we have a property to get the library_key that we can use here? I'm using something similar here: https://github.com/openedx/openedx-authz/pull/123/files#diff-5bd0f6e4e6ab9e8db665a0d717ca3e5867b9e0da168abf24493a3ceac4d99ad5R369-R376

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Of course, added: 0817961

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll fix the tests

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

@mariajgrimaldi mariajgrimaldi merged commit ee25f8a into openedx:main Oct 28, 2025
14 checks passed
@github-project-automation github-project-automation Bot moved this from Needs Triage to Done in Contributions Oct 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

4 participants